/*
 * Copyright 2011 Clean GWT
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
package com.cleangwt.validation.client.constraints.relative;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

/**
 * Constraints the value of the field must equals to the value of another's that is defined in the
 * 'field' element.
 * 
 * @author Jess
 * @version 1.0
 * @since 1.0
 */
@Target(FIELD)
@Retention(RUNTIME)
@Documented
@RelativeConstraint(validatedBy = EqValidation.class, relatives = "field", args = {
    "message(name1,name2)", "groups"})
public @interface Eq {
  /**
   * @return the relative field
   */
  String field();

  /**
   * @return the field name to composing the error message.
   */
  String name1();

  /**
   * @return the relative field name to composing the error message.
   */
  String name2();

  /**
   * @return The error message template.
   */
  String message() default "{ValidationMessages.Impl.eq}";

  /**
   * @return The groups the constraint belongs to.
   */
  String[] groups() default {};

  @Target(FIELD)
  @Retention(RUNTIME)
  @Documented
  @interface List {
    Eq[] value();
  }
}